Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Figure.meca: Improve documentation #3517

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Oct 15, 2024

Description of proposed changes

Some improvements of the documetation of Figure.meca:

  • rewrapp line length
  • add missing articels
  • shorten formulations

Preview: https://pygmt-dev--3517.org.readthedocs.build/en/3517/api/generated/pygmt.Figure.meca.html

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Oct 15, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Oct 15, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Oct 15, 2024
@yvonnefroehlich yvonnefroehlich changed the title WIP: DOC: Improve documentation of Figure.meca DOC: Improve documentation of Figure.meca Oct 15, 2024
@yvonnefroehlich yvonnefroehlich changed the title DOC: Improve documentation of Figure.meca WIP: DOC: Improve documentation of Figure.meca Oct 15, 2024
@yvonnefroehlich
Copy link
Member Author

/format

@yvonnefroehlich yvonnefroehlich changed the title WIP: DOC: Improve documentation of Figure.meca WIP: DOC/Figure.meca: Improve documentation Nov 1, 2024
@yvonnefroehlich yvonnefroehlich changed the title WIP: DOC/Figure.meca: Improve documentation WIP: Figure.meca: Improve documentation Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants